API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

products

Retrieves a products resource.

Retrieves a products resource.

Authorizations:
JWT
path Parameters
slug
required
string

products identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": {
    },
  • "brand": {
    },
  • "supplier": {
    },
  • "weight": "string",
  • "dimensionW": "string",
  • "dimensionH": "string",
  • "dimensionD": "string",
  • "time": "string",
  • "cost": "string",
  • "additionnalProductionCost": "string",
  • "costSpecial": "string",
  • "invQtyMin": "string",
  • "invQtyMax": "string",
  • "moq": "string",
  • "packageOrder": "string",
  • "inventoryTracking": true,
  • "rentTracking": true,
  • "countedInInventory": true,
  • "shippingTracking": true,
  • "notes": "string",
  • "notesInvoice": "string",
  • "notesBill": "string",
  • "notesRent": "string",
  • "notesProduction": "string",
  • "notesInventory": "string",
  • "notesShipping": "string",
  • "unitType": {
    },
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": {
    },
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": {
    },
  • "purchasable": true,
  • "billLineType": {
    },
  • "onDistribution": true,
  • "onWebsite": true,
  • "owningCorporation": {
    },
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "shortcode": "A",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "billLinesListing": "string",
  • "customPropertiesListing": "string",
  • "invoiceLinesListing": "string",
  • "rentsListing": "string",
  • "rentsChargedListing": "string",
  • "inventoryEntriesListing": "string",
  • "applicableCost": 0,
  • "translationTitlePropertyName": "string",
  • "applicablePrice": 0,
  • "inStock": 0,
  • "productStockProgressBar": 0,
  • "productStockRatio": 0,
  • "productStockPercentage": 0,
  • "correction": 0,
  • "lastInventoryEntry": "2019-08-24T14:15:22Z",
  • "productOptionsListing": "string",
  • "subProductOptionsListing": "string",
  • "productComponentsListing": "string",
  • "componentProductsListing": "string",
  • "translationsListing": "string",
  • "buyableBasePrice": 0,
  • "discount": 0,
  • "maxProductionCapacity": 0,
  • "applicableSupplierCode": "string",
  • "applicableClientCode": "string",
  • "consumable": true,
  • "translationDescriptionPropertyName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}